/*
 * OREKIT-X
 * Copyright 2002-2008 CS Communication & Systemes
 * 
 * Parts of this software package have been licensed to CS
 * Communication & Systemes (CS) under one or more contributor license
 * agreements.  See the NOTICE file distributed with this work for
 * additional information.
 *  
 * This is an experimental copy of OREKIT from www.orekit.org.
 * Please use the original OREKIT from orekit.org for normal work
 * unrelated to this research project.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License.  You
 * may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 */
package ore.forces.drag;

import ore.time.AbsoluteDate;


/** 
 * Interface for solar activity and magnetic activity data.
 * 
 * @author Fabien Maussion
 */
public interface JB2006InputParameters
    extends java.io.Serializable
{

    /** 
     * @return The available data range minimum date.
     */
    public AbsoluteDate getMinDate();

    /** 
     * @return The available data range maximum date.
     */
    public AbsoluteDate getMaxDate();

    /** 
     * Get the value of the instantaneous solar flux index
     * (1e<sup>-22</sup>*Watt/(m<sup>2</sup>*Hertz)).
     * Tabular time 1.0 day earlier.
     * @param date Current date
     * @return The instantaneous F10.7 index
     */
    public double getF10(AbsoluteDate date);

    /** 
     * Averaged 81-day centered F10.7 B index on the input time.
     * @param date Current date
     * @return The mean solar flux F10.7B index
     */
    public double getF10B(AbsoluteDate date);

    /** 
     * Get the EUV index (26-34 nm) scaled to F10.
     * Tabular time 1 day earlier.
     * @param date Current date
     * @return Scaled EUV S10 index
     */
    public double getS10(AbsoluteDate date);

    /** 
     * EUV 81-day averaged centered index.
     * @param date Current date
     * @return Mean EUV S10B index
     */
    public double getS10B(AbsoluteDate date);

    /** 
     * MG2 index scaled to F10.
     * @param date Current date
     * @return EUV S10 index
     */
    public double getXM10(AbsoluteDate date);

    /** 
     * MG2 81-day average centered index.
     * Tabular time 5.0 days earlier.
     * @param date Current date
     * @return Mean EUV S10B index
     */
    public double getXM10B(AbsoluteDate date);

    /** 
     * Geomagnetic planetary 3-hour index A<sub>p</sub>.
     * Tabular time 6.7 hours earlier.
     * @param date Current date
     * @return A<sub>p</sub> index
     */
    public double getAp(AbsoluteDate date);

}
